Inside Macintosh: Mac OS 8 Toolbox Reference /

Chapter 1 - Appearance Manager Reference / Appearance Manager Functions

Coordinating Colors and Patterns With the Current Theme /

SetThemeBackground

NEW WITH THE APPEARANCE MANAGER

Sets an element's background color or pattern to comply with the current theme.

pascal OSStatus SetThemeBackground (
                     ThemeBrush inBrush,
                     SInt16 inDepth,
                     Boolean inIsColorDevice);

inBrush

A value representing the pattern or color to which the background is to be set; see "Appearance-Compliant Brush Type Constants".

inDepth

The bit depth (in pixels) of the current graphics port.

inIsColorDevice

A Boolean value. Set to true to indicate that you are drawing on a color device. Set to false for a monochrome device.

function result

A result code. The result code appearanceBadBrushIndexErr indicates that the brush constant passed was not valid. For a list of other result codes, see "Result Codes".

DISCUSSION

The SetThemeBackground function should be called each time you wish to draw an element in a specified brush constant using Appearance Manager draw functions.

The constant in the inBrush parameter can represent a color or pattern, depending on the current theme. Because it could specify a pattern, remember to save and restore the pnPixPat and bkPixPat fields of your graphics port when saving the text and background colors. Because patterns in the bkPixPat field override the background color of the window, call the Window Manager function BackPat to set your background pattern to a normal white pattern. This will ensure that you can use RGBBackColor to set your background color to white, call the Window Manager function EraseRect, and get the expected results.